/*
 * Copyright 2011 Mark Davidson.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.dctmcommons;

import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;

/**
 * Fluent interface for invoking a server method. Please note that no
 * transactions are used during the operation.
 * @author Mark Davidson
 */
public interface IMethodBuilder {
	
	/**
	 * Specifies whether to run the method asynchronously.
	 * @return The IMethodBuilder instance
	 */
	public IMethodBuilder runAsynchronously();
	
	/**
	 * Specifies whether to save the results.
	 * @return The IMethodBuilder instance
	 */
	public IMethodBuilder saveResults();

	/**
	 * Specifies that the username, docbase name and ticket should be
	 * inferred from the IDfSession that is passed to the build method.
	 * @return The IMethodBuilder instance
	 */
	public IMethodBuilder useSessionCredentials();
	
	/**
	 * Adds the repository name argument.
	 * @param repositoryName The repository name
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder addRepository(String repositoryName);
	
	/**
	 * Adds the username argument.
	 * @param username The username
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder addUsername(String username);
	
	/**
	 * Adds the domain argument.
	 * @param domain The domain
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder addDomain(String domain);
	
	/**
	 * Adds the ticket argument.
	 * @param ticket The ticket
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder addTicket(String ticket);
	
	/**
	 * Adds the trace level argument.
	 * @param traceLevel The trace level
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder setTraceLevel(int traceLevel);
	
	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, String value);

	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, boolean value);
	
	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, int value);
	
	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, String[] value);

	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, boolean[] value);
	
	/**
	 * Adds a method argument.
	 * @param key The argument key
	 * @param value The argument value
	 * @return The IMethodHelper instance
	 */
	public IMethodBuilder add(String key, int[] value);
	
	/**
	 * Performs the method invocation. This method should be called last.
	 * @param session The session
	 * @return The method exit status
	 * @throws DfException The repository exception
	 */
	public int execute(IDfSession session) throws DfException;
}
